<!DOCTYPE html>
<html lang="ja">

<head>
  <meta charset="utf-8">
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <meta http-equiv="Content-Style-Type" content="text/css">
  <script src='../bbs.js'></script>

  <!-- Global site tag (gtag.js) - Google Analytics -->
  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-120820034-1"></script>

  <link href="../bbs.css" type="text/css" rel="stylesheet">
  <link rel="shortcut icon" href="/favicon.ico">
  <title>doxygenとコメントの書き方 | サクラエディタ過去ログ</title>
</head>
<body>
<ul class="side">
        <a href="./" class="toindex">◀ANSI版開発トップへ</a>
        <li><div class="list-title">
    <span class="no">199</span>
    <a class="thread-title" href="199.html#199">doxygenとコメントの書き方</a></div>
    <ul><li><div class="list-title">
    <span class="no">200</span>
    <a class="thread-title" href="199.html#200">Re:doxygenとコメントの書き方</a></div>
    <ul><li><div class="list-title">
    <span class="no">203</span>
    <a class="thread-title" href="199.html#203">Re2:doxygenとコメントの書き方</a></div>
    </li></ul></li></ul></li>
    </ul><ul class="main"><li><section><h1 id=199>
    <span class="no">[199]</span>
    <a class="thread-title" href="#199">doxygenとコメントの書き方</a>
    <span class="author">げんた</span>
    <time datetime="2001-03-19T21:40:51">2001年03月19日 21:40</time></h1>
    <div class="body">doxygen <a href=http://www.doxygen.org/ target=_top>http://www.doxygen.org/</a> というソースコードからドキュメント(HTML/RTF/LaTeX/UNIX man)を自動生成するソフトを使ってみました。<br>クラス階層が画像で表示されたりとかなり高度なことができるソフトです。ソースコード中にあるコメントから解説を書いてくれるのですが、明示的に指定したQt及びJavaDoc形式コメントのみを拾い出すので現時点では全くコメントは表示されません。<br><br>そこで、今後コメントを入れるときは関数や引数の解説などドキュメントに含められそうなものはこの形式に従うようにするというのはどうでしょうか。<br><br>基本的なルールはコメントマークの直後に!を入れるだけで、/*! とか //! で始めます。<br><br>ただ、こういうことを書くとじぇぷろさんが張り切ってあちこち直し始めてしまい差分のほとんどがコメント行になってしまうという状況は勘弁してほしいと思います。あくまで直したときについでに入れるということで。</div></section>
    <ul><li><section><h1 id=200>
    <span class="no">[200]</span>
    <a class="thread-title" href="#200">Re:doxygenとコメントの書き方</a>
    <span class="author">げんた</span>
    <time datetime="2001-03-21T00:49:02">2001年03月21日 00:49</time></h1>
    <div class="body">▼ げんたさん<br>&gt; あくまで直したときについでに<br>と自分で書いておきながら、CEOLとCPassiveTimerにコメントをつけてしまいました。CShareDataなど既に付いているコメントの先頭に!をつけたくなる衝動に駆られますが、それをやってしまうとCShareDataのほとんどが変更行になってしまうしなぁ。<br>差分を気にして何もしないよりはできるときにコメントも充実させた方がいいんでしょうかね。<br><br>コメントの付与基準並びにドキュメント生成方法をホームページにUpしました。</div></section>
    <ul><li><section><h1 id=203>
    <span class="no">[203]</span>
    <a class="thread-title" href="#203">Re2:doxygenとコメントの書き方</a>
    <span class="author">げんた</span>
    <time datetime="2001-03-22T18:18:42">2001年03月22日 18:18</time></h1>
    <div class="body">doxygenで生成したドキュメントを以下のURLに置きました。これはあくまでサンプルなので今後更新されるという保証はありません。<br><a href=http://members.tripod.co.jp/sakura_editor/docsrc/ target=_top>http://members.tripod.co.jp/sakura_edito<br>r/docsrc/</a><br><br>ほとんど中身が入っていないのですが、中身のあるところを見たい人は下のURLからどうぞ。<br><a href=http://members.tripod.co.jp/sakura_editor/docsrc/class_CEOL.html target=_top>http://members.tripod.co.jp/sakura_edito<br>r/docsrc/class_CEOL.html</a><br><a href=http://members.tripod.co.jp/sakura_editor/docsrc/class_CPassiveTimer.html target=_top>http://members.tripod.co.jp/sakura_edito<br>r/docsrc/class_CPassiveTimer.html</a><br><br>対応するソースコードはeGroupsにあります。コメント挿入以外にバックアップ間隔指定の横にあるスピンボタンが動く(byみくさん)点が最終リリースとは異なります。</div></section>
    </li></ul></li></ul></li></ul></body></html>